/*
 * IntervalType.java
 *
 * Copyright (C) 2002-2006 Alexei Drummond and Andrew Rambaut
 *
 * This file is part of BEAST.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * BEAST is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 *  BEAST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BEAST; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package dr.evolution.coalescent;

/**
 * Specifies the interval types.
 *
 * @version $Id: IntervalType.java,v 1.9 2005/05/24 20:25:56 rambaut Exp $
 *
 * @author Andrew Rambaut
 * @author Alexei Drummond
 */
public class IntervalType implements Comparable {

	/**
	 * Denotes an interval at the end of which a new sample addition is
	 * observed (i.e. the number of lineages is larger in the next interval).
	 */
	public static final IntervalType SAMPLE = new IntervalType("sample");

	/** Denotes an interval after which a coalescent event is observed
	  * (i.e. the number of lineages is smaller in the next interval) */
	public static final IntervalType COALESCENT = new IntervalType("coalescent");

    /**
     * Denotes an interval at the end of which a migration event occurs.
     * This means that the colour of one lineage changes.
     */
    public static final IntervalType MIGRATION = new IntervalType("migration");

    /**
     * Denotes an interval at the end of which nothing is
     * observed (i.e. the number of lineages is the same in the next interval).
     */
    public static final IntervalType NOTHING = new IntervalType("nothing");

	/**
	 * private constructor.
	 */
	private IntervalType(String name) {
		this.name = name;
		ordinal = nextOrdinal;
		nextOrdinal++;
	}

	public int compareTo(Object o) {
		return ordinal - ((IntervalType)o).ordinal;
	}

	public String toString() { return name; }

	private final String name;
	private final int ordinal;

	private static int nextOrdinal = 0;
}